Coordinate systems

CoordSystemsContainer:
Find(FindEntity)

Find.

Parameters:

FindEntity (Entity/str) – Entity name to find

Returns:

Entity found

Return type:

Entity

GlobalCartesian

Global Cartesian.

Type:

KCoordinateSystem

activeCoordSystem(Active)

: Active coordinate system

Parameters:

Active (str) – New active coordinate system name.

CoordSystem(EntityName)

Obtains an entity given its name

Parameters:

EntityName (str) – Entity name.

CoordSystemsModelGroup(GroupName)

Obtains a group given its name

Parameters:

GroupName (str) – Group name.

createCartesianCoordSys(Origin, XVector, SetAsActive)

Cartesian: Create a Cartesian coordinate system

Alias: cartesianCoordSys
Constraints: 2 dimensions
Parameters:

  • Origin (Point) – Origin: Origin of the coordinate system.

  • XVector (Vector) – X Dir: X axis direction. Conditions: A vector cannot have zero magnitude.

  • SetAsActive (bool) – Activate: Set the object as the active one.

createCartesianCoordSys(Origin, XVector, ZVector, SetAsActive)

Cartesian: Create a Cartesian coordinate system

Alias: cartesianCoordSys
Constraints: 3 dimensions
Parameters:

  • Origin (Point) – Origin: Origin of the coordinate system.

  • XVector (Vector) – X Dir: X axis direction. Conditions: A vector cannot have zero magnitude. X axis can not be parallel to Z axis.

  • ZVector (Vector) – Z Dir: Z axis direction. Conditions: A vector cannot have zero magnitude. X axis can not be parallel to Z axis.

  • SetAsActive (bool) – Activate: Set the object as the active one.

createCartesianCoordSys(Name, Origin, XVector, SetAsActive)

Cartesian: Create a Cartesian coordinate system

Alias: cartesianCoordSys
Constraints: 2 dimensions
Parameters:

  • Name (str) – Name. Conditions: “” input must be non-empty.

  • Origin (Point) – Origin: Origin of the coordinate system.

  • XVector (Vector) – X Dir: X axis direction. Conditions: A vector cannot have zero magnitude.

  • SetAsActive (bool) – Activate: Set the object as the active one.

createCartesianCoordSys(Name, Origin, XVector, ZVector, SetAsActive)

Cartesian: Create a Cartesian coordinate system

Alias: cartesianCoordSys
Constraints: 3 dimensions
Parameters:

  • Name (str) – Name. Conditions: “” input must be non-empty.

  • Origin (Point) – Origin: Origin of the coordinate system.

  • XVector (Vector) – X Dir: X axis direction. Conditions: A vector cannot have zero magnitude. X axis can not be parallel to Z axis.

  • ZVector (Vector) – Z Dir: Z axis direction. Conditions: A vector cannot have zero magnitude. X axis can not be parallel to Z axis.

  • SetAsActive (bool) – Activate: Set the object as the active one.

createCylindricalCoordSys(Origin, XVector, ZVector, SetAsActive)

Cylindrical: Create a cylindrical coordinate system

Alias: cylindricalCoordSys
Constraints: 3 dimensions
Parameters:

  • Origin (Point) – Origin: Origin of the coordinate system.

  • XVector (Vector) – X Dir: X axis direction. Conditions: A vector cannot have zero magnitude. X axis can not be parallel to Z axis.

  • ZVector (Vector) – Z Dir: Z axis direction. Conditions: A vector cannot have zero magnitude. X axis can not be parallel to Z axis.

  • SetAsActive (bool) – Activate: Set the object as the active one.

createCylindricalCoordSys(Name, Origin, XVector, ZVector, SetAsActive)

Cylindrical: Create a cylindrical coordinate system

Alias: cylindricalCoordSys
Constraints: 3 dimensions
Parameters:

  • Name (str) – Name. Conditions: “” input must be non-empty.

  • Origin (Point) – Origin: Origin of the coordinate system.

  • XVector (Vector) – X Dir: X axis direction. Conditions: A vector cannot have zero magnitude. X axis can not be parallel to Z axis.

  • ZVector (Vector) – Z Dir: Z axis direction. Conditions: A vector cannot have zero magnitude. X axis can not be parallel to Z axis.

  • SetAsActive (bool) – Activate: Set the object as the active one.

createPolarCoordSys(Origin, XVector, SetAsActive)

Polar: Create a polar coordinate system

Alias: polarCoordSys
Constraints: 2 dimensions
Parameters:

  • Origin (Point) – Origin: Origin of the coordinate system.

  • XVector (Vector) – X Dir: X axis direction. Conditions: A vector cannot have zero magnitude.

  • SetAsActive (bool) – Activate: Set the object as the active one.

createPolarCoordSys(Name, Origin, XVector, SetAsActive)

Polar: Create a polar coordinate system

Alias: polarCoordSys
Constraints: 2 dimensions
Parameters:

  • Name (str) – Name. Conditions: “” input must be non-empty.

  • Origin (Point) – Origin: Origin of the coordinate system.

  • XVector (Vector) – X Dir: X axis direction. Conditions: A vector cannot have zero magnitude.

  • SetAsActive (bool) – Activate: Set the object as the active one.

createSphericalCoordSys(Origin, XVector, ZVector, SetAsActive)

Spherical: Create a spherical coordinate system

Alias: sphericalCoordSys
Constraints: 3 dimensions
Parameters:

  • Origin (Point) – Origin: Origin of the coordinate system.

  • XVector (Vector) – X Dir: X axis direction. Conditions: A vector cannot have zero magnitude. X axis can not be parallel to Z axis.

  • ZVector (Vector) – Z Dir: Z axis direction. Conditions: A vector cannot have zero magnitude. X axis can not be parallel to Z axis.

  • SetAsActive (bool) – Activate: Set the object as the active one.

createSphericalCoordSys(Name, Origin, XVector, ZVector, SetAsActive)

Spherical: Create a spherical coordinate system

Alias: sphericalCoordSys
Constraints: 3 dimensions
Parameters:

  • Name (str) – Name. Conditions: “” input must be non-empty.

  • Origin (Point) – Origin: Origin of the coordinate system.

  • XVector (Vector) – X Dir: X axis direction. Conditions: A vector cannot have zero magnitude. X axis can not be parallel to Z axis.

  • ZVector (Vector) – Z Dir: Z axis direction. Conditions: A vector cannot have zero magnitude. X axis can not be parallel to Z axis.

  • SetAsActive (bool) – Activate: Set the object as the active one.